¶ Primeiros Passos para Utilizar o SYN Privado

Bem-vindo à integração com o Syn Privado! Este guia foi criado para ajudá-lo a configurar e iniciar sua integração de maneira simples e eficiente.

Observação: Se você utiliza o Questor Cloud, pode pular a Etapa 1 deste guia, pois essa configuração será realizada pelo nosso time técnico de monitoramento.

¶ 1° Passo: Configurar o nServer

Na pasta de instalação do Questor, abra a aplicação nServerConfig, responsável por iniciar e manter o Syn Privado em execução.

Ao abrir o nServerConfig, você verá a seguinte interface:

Nome do Host: Apelido para a conexão.

Porta: Informe uma porta disponível e com as liberações de firewall necessárias.

Porta Https: Se um certificado digital for instalado, insira 443. Caso contrário, deixe em branco.

Limite Memória (%): Informe o limite máximo de uso de memória RAM pelo nHTTP. Recomendamos valores entre 90% e 95%.

Limite Clients: Insira -1 na aba nHTTP.

Limite Minutos Ocioso: Defina o período em que o nHTTP irá se manter ativo após nenhuma interação com ele. Recomendamos que seja informado o valor de 60.

Limite de CPU, Memória e Executáveis Workers (%): Configure como 80, 80 e 50, respectivamente.

Iniciar Automaticamente: Marque esta opção para que os serviços sejam iniciados automaticamente ao abrir o nServerConfig.

Após concluir a configuração do Syn Privado, você pode testar a conexão utilizando o seguinte endpoint: /TnWebDMDadosGerais/PegarVersaoQuestor.

Se a configuração foi realizada corretamente, o endpoint retornará a seguinte mensagem:

¶ 2° Passo - Realizar o Login

Para utilizar a API com segurança, é necessário realizar o login antes de acessar os Endpoints. Caso contrário, será exibida a mensagem de erro ao tentar qualquer operação.

¶ Como realizar o login

Utilize o Endpoint POST - /Home/LoginModulo e preencha os seguintes parâmetros:

• O Body será do tipo "form-data".

• LogonName: Usuário e conexão com o banco de dados no formato usuario@conexão.

• Exemplo: claudio@questor.

  • PlainPassword: A senha correspondente ao usuário informado.

¶ Exemplo de Requisição

http://localhost:8080/home/LoginModulo?LogonName=administrador@questor&PlainPassword=masterkey

Como resposta, você receberá um Bearer Token temporário que será utilizado como Authorization em todos os próximos Endpoints:

⚠️ Atenção: O token acima é um exemplo e será gerado de forma aleatória para cada login.

¶ Logout

Para encerrar a sessão do usuário, utilize o seguinte endpoint:

GET - /home/Logout

Parâmetro obrigatório:

• Token: O Token recebido no Endpoint de login deve ser inserido como Bearer Token.

Exemplo de Requisição

http://localhost:8080/home/Logout

¶ Resposta Esperada:

Se a solicitação for processada corretamente, o sistema retornará uma página HTML, indicando que o logout foi realizado com sucesso:

¶ 3° Passo - Identificar o Nome interno das rotinas

Para executar uma rotina, é necessário identificar o nome interno da mesma.

¶ Como identificar no Questor Desktop

Acesse a rotina desejada e pressione as teclas ALT + ENTER simultaneamente. Uma janela será exibida com o nome interno.

¶ Como identificar no Questor Cloud

Utilize o Endpoint GET - api/TnWebDMMenus/Pegar com o parâmetro:

• _ATipo

Para o parâmetro _ATipo deve ser inserido um dos valores abaixo:

¶ Exemplo de Requisição

http://localhost:8080/api/TnWebDMMenus/Pegar

A resposta retornará os nomes internos de todas as rotinas separadas por módulos. O nome interno estará na tag "Name".

¶ 4° Passo - Parâmetros da rotina

Após identificar o nome interno da rotina, descubra os parâmetros necessários para sua execução.

Endpoint para identificar parâmetros
Use o Endpoint GET - api/TnWebDMDadosObjetos/Pegar com o parâmetro:

• _AActionName

¶ Exemplo de Requisição

Para a rotina de importação de notas fiscais eletrônicas (NFE):

http://localhost:8080/api/TnWebDMDadosObjetos/Pegar?_AActionName=TnArqDPImportarLctoFisNFEXML

A resposta exibirá:

• "Name": Nome do parâmetro a ser informado no Body.
• "Required": Indica se o parâmetro é obrigatório (True) ou não (False).

¶ Finalizando os Primeiros Passos

Parabéns! Se você chegou até aqui, sua integração inicial está configurada e funcional. Você já está pronto para começar a explorar os recursos avançados e personalizar sua integração para atender às necessidades específicas do seu negócio.

¶ Próximos passos

Rotinas do Sistema: Avançando na documentação você poderá verificar como executar uma rotina do sistema Questor através do Syn Privado.

Relatórios do Sistema: Execute relatórios nativos ou personalizados do sistema com o Syn Privado.

Importação e Exportação de Dados: Importe e exporte dados do sistema Questor utilizando o Syn Privado